Install Docular
Now that you have NodeJS, NPM, and Grunt installed, it's time to install the grunt-docular package.
The grunt-docular package will bring in Docular as a dependency and exposes tasks that hook into the Docular package.
cd <your project root>
npm install grunt-docular
grunt.loadNpmTasks('grunt-docular');
docular: { groups: [], showDocularDocs: true, showAngularDocs: true }
grunt.registerTask('default', ['docular']);
The final Gruntfile.js with mods should look like this:
module.exports = function(grunt) { // Project configuration. grunt.initConfig({ pkg: grunt.file.readJSON('package.json'), docular: { groups: [], showDocularDocs: true, showAngularDocs: true } }); // Load the plugin that provides the "docular" tasks. grunt.loadNpmTasks('grunt-docular'); // Default task(s). grunt.registerTask('default', ['docular']); };
Note that we have enabled the inclusion of the AngularJS docs and Docular docs as an example to make sure everything is working. You can turn them off later when you have created your own "groups".
grunt
Running "docular" task -------- generating documentation objects -------- Extracting docular Documentation For Section "docularinstall"... Extracting docular Documentation For Section "docularoverview"... Extracting docular Documentation For Section "docularext"... Extracting docular Documentation For Section "docular"... Extracting angular Documentation For Section "api"... Extracting angular Documentation For Section "guide"... Extracting angular Documentation For Section "tutorial"... Extracting angular Documentation For Section "misc"... -------- generating partials directories for groups -------- -------- generating partials directories for sections -------- -------- merging child docs with parents -------- BAD LINK: documentation/angular/cookbook/index -------- generating partials -------- -------- generating keyword data -------- -------- generating index.html page -------- -------- ordering and concatenating doc_api css and js -------- -------- generating report -------- DONE! Generated 229 pages in 2964 ms. Partials per second : 77
grunt docular-server
Documentation server running at http://127.0.0.1:8000/